<?xml version="1.0"?>
<doc>
    <assembly>
        <name>TVA.Windows</name>
    </assembly>
    <members>
        <member name="T:TVA.Windows.Forms.AboutDialog">
            <summary>
            Represents a common about dialog box.
            </summary>
        </member>
        <member name="F:TVA.Windows.Forms.AboutDialog.components">
            <summary>
            Required designer variable.
            </summary>
        </member>
        <member name="M:TVA.Windows.Forms.AboutDialog.Dispose(System.Boolean)">
            <summary>
            Clean up any resources being used.
            </summary>
            <param name="disposing">true if managed resources should be disposed; otherwise, false.</param>
        </member>
        <member name="M:TVA.Windows.Forms.AboutDialog.InitializeComponent">
            <summary>
            Required method for Designer support - do not modify
            the contents of this method with the code editor.
            </summary>
        </member>
        <member name="M:TVA.Windows.Forms.AboutDialog.#ctor">
            <summary>
            Initializes a new instance of the <see cref="T:TVA.Windows.Forms.AboutDialog"/> class.
            </summary>
        </member>
        <member name="M:TVA.Windows.Forms.AboutDialog.HideDisclaimerTab">
            <summary>
            Conceals the tab where disclaimer text is displayed.
            </summary>
            <remarks></remarks>
        </member>
        <member name="M:TVA.Windows.Forms.AboutDialog.HideApplicationTab">
            <summary>
            Conceals the tab where application information is displayed.
            </summary>
            <remarks></remarks>
        </member>
        <member name="M:TVA.Windows.Forms.AboutDialog.HideAssembliesTab">
            <summary>
            Conceals the tab where assemblies and their information is displayed.
            </summary>
            <remarks></remarks>
        </member>
        <member name="M:TVA.Windows.Forms.AboutDialog.SetCompanyUrl(System.String)">
            <summary>
            Sets the URL that will be opened when the logo is clicked.
            </summary>
            <param name="url">URL of the company's home page.</param>
            <remarks></remarks>
        </member>
        <member name="M:TVA.Windows.Forms.AboutDialog.SetCompanyLogo(System.String)">
            <summary>
            Sets the logo that is to be displayed in the About Dialog.
            </summary>
            <param name="logoFile">Location of the logo file.</param>
            <remarks></remarks>
        </member>
        <member name="M:TVA.Windows.Forms.AboutDialog.SetCompanyLogo(System.IO.Stream)">
            <summary>
            Sets the logo that is to be displayed in the About Dialog.
            </summary>
            <param name="logoStream">System.IO.Stream of the logo.</param>
            <remarks></remarks>
        </member>
        <member name="M:TVA.Windows.Forms.AboutDialog.SetCompanyDisclaimer(System.String)">
            <summary>
            Sets the disclaimer text that is to be displayed in the About Dialog.
            </summary>
            <param name="disclaimerFile">Location of the file that contains the disclaimer text.</param>
            <remarks></remarks>
        </member>
        <member name="M:TVA.Windows.Forms.AboutDialog.SetCompanyDisclaimer(System.IO.Stream)">
            <summary>
            Sets the disclaimer text that is to be displayed in the About Dialog.
            </summary>
            <param name="disclaimerStream">System.IO.Stream of the disclaimer text.</param>
            <remarks></remarks>
        </member>
        <member name="T:TVA.Windows.Forms.PropertyGridExtensions">
            <summary>
            Defines extension functions for the <see cref="T:System.Windows.Forms.PropertyGrid"/> control.
            </summary>
        </member>
        <member name="M:TVA.Windows.Forms.PropertyGridExtensions.AdjustLabelRatio(System.Windows.Forms.PropertyGrid,System.Double)">
            <summary>
            Adjusts a property grid's label ratio
            </summary>
            <param name="grid">Property grid to adjust</param>
            <param name="ratio">Ratio to use use for label column</param>
            <remarks>
            <para>Smaller ratios (e.g., 1.75) produce a wider label column.</para>
            <para>
            This function only has an effect on property grids when their Visible property is set to True.  To use
            this on an initially hidden property grid - set the property grid's Visible property to True at design
            time, call this function during form load, then set the Visible property to False.
            </para>
            <para>
            This function was written to work with the .NET 2.0 PropertyGrid control.  Note that reflection is used
            to set private properties of the property grid and as a result this function may not work with future
            versions of the .NET property grid.
            </para>
            </remarks>
        </member>
        <member name="M:TVA.Windows.Forms.PropertyGridExtensions.AdjustCommentAreaHeight(System.Windows.Forms.PropertyGrid,System.Int32)">
            <summary>
            Adjusts a property grid's comment area height
            </summary>
            <param name="grid">Property grid to adjust</param>
            <param name="lines">Number of lines to display in comment area</param>
            <remarks>
            <para>
            This function only has an effect on property grids when their Visible property is set to True.  To use
            this on an initially hidden property grid - set the property grid's Visible property to True at design
            time, call this function during form load, then set the Visible property to False.
            </para>
            <para>
            This function was written to work with the .NET 2.0 PropertyGrid control.  Note that reflection is used
            to set private properties of the property grid and as a result this function may not work with future
            versions of the .NET property grid.
            </para>
            </remarks>
        </member>
        <member name="T:TVA.Windows.SecureWindow">
            <summary>
            Represents a WPF window secured using role-based security.
            </summary>
            <seealso cref="T:TVA.Security.ISecurityProvider"/>
            <example>
            Required config file entries:
            <code>
            <![CDATA[
            <?xml version="1.0"?>
            <configuration>
              <configSections>
                <section name="categorizedSettings" type="TVA.Configuration.CategorizedSettingsSection, TVA.Core" />
              </configSections>
              <categorizedSettings>
                <securityProvider>
                  <add name="ApplicationName" value="SEC_APP" description="Name of the application being secured as defined in the backend security datastore."
                    encrypted="false" />
                  <add name="ConnectionString" value="Primary={Server=DB1;Database=AppSec;Trusted_Connection=True};Backup={Server=DB2;Database=AppSec;Trusted_Connection=True}"
                    description="Connection string to be used for connection to the backend security datastore."
                    encrypted="false" />
                  <add name="ProviderType" value="TVA.Security.SqlSecurityProvider, TVA.Security"
                    description="The type to be used for enforcing security." encrypted="false" />
                  <add name="IncludedResources" value="*Window*=*" description="Semicolon delimited list of resources to be secured along with role names."
                    encrypted="false" />
                  <add name="ExcludedResources" value="" description="Semicolon delimited list of resources to be excluded from being secured."
                    encrypted="false" />
                </securityProvider>
                <activeDirectory>
                  <add name="PrivilegedDomain" value="" description="Domain of privileged domain user account."
                    encrypted="false" />
                  <add name="PrivilegedUserName" value="" description="Username of privileged domain user account."
                    encrypted="false" />
                  <add name="PrivilegedPassword" value="" description="Password of privileged domain user account."
                    encrypted="true" />
                </activeDirectory>
              </categorizedSettings>
            </configuration>
            ]]>
            </code>
            </example>
            <example>
            XAML to be used for the WPF window that inherits from <see cref="T:TVA.Windows.SecureWindow"/>:
            <code>
            <![CDATA[
            <src:SecureWindow x:Class="SecureWpfApplication.Window1"
                xmlns="http://schemas.microsoft.com/winfx/2006/xaml/presentation"
                xmlns:x="http://schemas.microsoft.com/winfx/2006/xaml" 
                xmlns:src="clr-namespace:TVA.Windows;assembly=TVA.Windows"
                Title="Window1" Height="300" Width="300">
                <Grid>
            
                </Grid>
            </src:SecureWindow>
            ]]>
            </code>
            </example>
        </member>
        <member name="M:TVA.Windows.SecureWindow.#ctor">
            <summary>
            Initializes a new instance of the <see cref="T:TVA.Windows.SecureWindow"/> class.
            </summary>
        </member>
        <member name="M:TVA.Windows.SecureWindow.GetResourceName">
            <summary>
            Gets the name of resource being accessed.
            </summary>
            <returns>Name of the resource being accessed.</returns>
        </member>
        <member name="T:TVA.Windows.Forms.SecureForm">
            <summary>
            Represents a windows form secured using role-based security.
            </summary>
            <seealso cref="T:TVA.Security.ISecurityProvider"/>
            <example>
            Required config file entries:
            <code>
            <![CDATA[
            <?xml version="1.0"?>
            <configuration>
              <configSections>
                <section name="categorizedSettings" type="TVA.Configuration.CategorizedSettingsSection, TVA.Core" />
              </configSections>
              <categorizedSettings>
                <securityProvider>
                  <add name="ApplicationName" value="SEC_APP" description="Name of the application being secured as defined in the backend security datastore."
                    encrypted="false" />
                  <add name="ConnectionString" value="Primary={Server=DB1;Database=AppSec;Trusted_Connection=True};Backup={Server=DB2;Database=AppSec;Trusted_Connection=True}"
                    description="Connection string to be used for connection to the backend security datastore."
                    encrypted="false" />
                  <add name="ProviderType" value="TVA.Security.SqlSecurityProvider, TVA.Security"
                    description="The type to be used for enforcing security." encrypted="false" />
                  <add name="IncludedResources" value="*Form*=*" description="Semicolon delimited list of resources to be secured along with role names."
                    encrypted="false" />
                  <add name="ExcludedResources" value="" description="Semicolon delimited list of resources to be excluded from being secured."
                    encrypted="false" />
                </securityProvider>
                <activeDirectory>
                  <add name="PrivilegedDomain" value="" description="Domain of privileged domain user account."
                    encrypted="false" />
                  <add name="PrivilegedUserName" value="" description="Username of privileged domain user account."
                    encrypted="false" />
                  <add name="PrivilegedPassword" value="" description="Password of privileged domain user account."
                    encrypted="true" />
                </activeDirectory>
              </categorizedSettings>
            </configuration>
            ]]>
            </code>
            </example>
        </member>
        <member name="M:TVA.Windows.Forms.SecureForm.#ctor">
            <summary>
            Initializes a new instance of the <see cref="T:TVA.Windows.Forms.SecureForm"/> class.
            </summary>
        </member>
        <member name="M:TVA.Windows.Forms.SecureForm.GetResourceName">
            <summary>
            Gets the name of resource being accessed.
            </summary>
            <returns>Name of the resource being accessed.</returns>
        </member>
        <member name="F:TVA.Windows.Forms.SecureForm.components">
            <summary>
            Required designer variable.
            </summary>
        </member>
        <member name="M:TVA.Windows.Forms.SecureForm.Dispose(System.Boolean)">
            <summary>
            Clean up any resources being used.
            </summary>
            <param name="disposing">true if managed resources should be disposed; otherwise, false.</param>
        </member>
        <member name="M:TVA.Windows.Forms.SecureForm.InitializeComponent">
            <summary>
            Required method for Designer support - do not modify
            the contents of this method with the code editor.
            </summary>
        </member>
    </members>
</doc>
